home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 3 / Info_Mac_1994-01.iso / Development / Source / Macintosh Tracker 1.1 Source / Original Tracker 3.10 Source / docs / tracker.doc < prev    next >
Text File  |  1993-05-22  |  8KB  |  201 lines
  1. History:
  2. -------
  3. soundtracker was originally written by Karsten Obarsky for the amiga, a
  4. loong time ago. There have been numerous variants built upon it, the
  5. latest being protracker.
  6.  
  7. Liam Corner had the original idea of a player for the sunstation, and
  8. proved that it was possible. 
  9. I wouldn't have thought of writing it myself, but armed with his original code, 
  10. I used my knowledge of the amiga tracker format to `add some improvements'. 
  11. Of course, I ended up rewriting the whole code. At that point, it ran on 
  12. silicon graphics indigos and suns.
  13.  
  14. Steve Haehnichen wrote a soundblaster variant of that program which I have 
  15. finally added to the other versions. I did not have any news from him for
  16. sometime now, so I've decided to distribute it all. If it doesn't work as it is,
  17. it shouldn't be difficult to fix. 
  18.  
  19. Hannu Savolainen sent me the linux version and helped me put it up to date.
  20. This one should work.
  21.  
  22. Many thanks also to Matthew Donaldson and Joerg-Cyril Hoehle for sending me 
  23. very useful bug reports and giving us an ever better sounding player !
  24. Also, thanks to Loic Grenie, whose unix expertise I used extensively to
  25. get bg/fg routines to `work' (remaining bugs are mine, of course).
  26.  
  27.  
  28. I also heard of some variants on the NeXt which I have been too busy to get
  29. yet. 
  30.  
  31. If you want to modify tracker or make it run on another machine, or correct
  32. problems, please do so.
  33. HOWEVER, IF YOU INTEND TO PORT IT TO ANOTHER MACHINE, I WOULD VERY MUCH
  34. APPRECIATE THAT YOU CHECK UP WITH ME FIRST. 
  35. There just might already be a port in progress, or I might have a newer
  36. version. Even so, I'd like to be able to maintain one source instead of
  37. a bazillion of version. My e-mail is espie@ens.fr, not liable to change
  38. for some time.
  39.  
  40. IMPORTANT NOTE
  41. --------------
  42. I am afraid I won't be able to follow up on the program, nor on my e-mail
  43. for the ten months to come. So if  you don't get any answers from me for some
  44. time, that's quite normal, you're on your own...
  45.  
  46. PRELIMINARY
  47. -----------
  48. As I am a lazy person, this file tends to change more slowly than the tracker
  49. program itself.  Some options may no longer exist, some may have been added.
  50. Many things may be different.  I mainly try to get out a working, efficient
  51. reasonably bug-free program.  If I manage to write corresponding docs, fine !
  52. If I don't, tough luck ! Anyhow, looking at the source file should provide
  53. you with enough insight for everything.
  54. --
  55.  
  56. This is tracker version 3.10. It includes numerous bug-fixes, a much better
  57. command line interface and runtime interface, and improved support for 
  58. compressed formats--thanks to Steve for this.  As this version was not tested
  59. on soundblaster PC, you might need to do some tweaking around to make it 
  60. work for such a machine. If you would be kind enough as to send me 
  61. any requested changes, I would appreciate it. Thanks to Hannu Savolainen for
  62. helping me getting the linux version upto date.
  63.  
  64. To build tracker, you should have a good look at the makefile.
  65. Usually, just changing the install dir, doing a make machine_name, then
  66. make install should be enough.  You may want to install tracker by hand,
  67. as it is trivial.
  68.  
  69. tracker is a public domain program, it is not guaranteed to do anything
  70. at all, either useful or useless. You've been warned, use it at your own risk. 
  71. This said, there doesn't seem to be any relevant bugs left in the current
  72. revision of code, and it is getting more and more stable.
  73.  
  74. ``Soundtracker'' is a family of music composition programs
  75. that exists on the amiga. The resulting data files (modules)
  76. have been appearing on ftp sites for some time now.
  77.  
  78. For a machine with sufficient horsepower and some audio capability,
  79. it is possible to emulate the amiga audio hardware in real time,
  80. and play those modules.
  81. After that, you're only limited by the machine's capabilities. The
  82. sparc is a bit poor (8Khz sampling), in contrast with the indigo,
  83. which gives an almost perfect rendition of most modules.
  84.  
  85. This release of tracker supports most amiga soundtracker file formats,
  86. and plays most of the existing effects, so that about 99% of the modules
  87. are output correctly.
  88.  
  89. There is no man page (write it yourself), but a short description of
  90. the options can be obtained by running tracker without arguments.
  91.  
  92. Here is some supplementary information.
  93.  
  94. Environment variables:
  95. OVERSAMPLE can be used to control the accuracy of the reproduction.
  96. (The number of samples used to output one audio word).
  97. The higher, the better, but the more CPU it will use. The default
  98. value (1) is quite good at high frequencies, but not so for, for instance
  99. a poor sparc station's 8000 Hz. You can try, say, 2 or 3. After that,
  100. there won't be any noticeable improvement, and anyway, the program won't
  101. be fast enough to keep up with the output rate. Note that the program is
  102. special-cased for the default value (1), which should be significantly faster
  103. on some architectures.
  104.  
  105. FREQUENCY can be used to set the audio output at a specific frequency
  106. (if the hardware supports it). The hardware will decide which frequency
  107. to actually use, according to other external parameters.
  108.  
  109. MONO can be used to force mono output, which uses less
  110. cpu power.
  111.  
  112. TRANSPOSE is the number of halftones to transpose each note (>0 is higher).
  113. Useful for low frequency sparcs which can't play some tunes accurately, or
  114. when you get bored...
  115.  
  116. MODPATH can be set to be a path where you wish to look for mod files. This
  117. is a sh-styled path: setenv MODPATH dir1:dir2:...
  118.  
  119. Command line switches:
  120. -stereo/-mono: 
  121.     switch between stereo/mono output
  122. -mix <percent>: 
  123.     for stereo output, decide how to mix left/right channels.
  124.     0 is spatial stereo, 100 is mono. The change tends to
  125.     be exponential, so you may want to experiment with values 
  126.     around 90+.
  127. -frequency <freq>:
  128.     ask for a given output frequency. The normal output frequency
  129.     is a `normal' frequency for your machine. <freq> will be rounded
  130.     to a near available value.
  131. -oversample <n>:
  132.     where n is usually 1, 2 or 3. Try to use 1,2 or 3 sample values
  133.     to accurately render a given sample. Changing the frequency 
  134.     usually works better, but there might be cases where 2 or 3 gives
  135.     you a better rendering for a given module. Big cpu-eater.
  136. -new/old/both:
  137.     select a soundtracker format, between new (31 instr), old (15 instr)
  138.     and both (auto-detect what's going on). You should only use it if
  139.     tracker gets very confused on a module.
  140. -picky:
  141.     do not allow for any problems in a module.
  142. -tolerant:
  143.     allow for many problems that would normally stop a module
  144. -repeats / -repeats <n>:
  145.     repeat each module n times. With no value (or a 0), repeat the
  146.     module forever.
  147. -verbose:
  148.     show a sample listing for the module.
  149. -show:
  150.     scroll-display the module being played.
  151. -sync:
  152.     try to synchronize that scroll display with what you hear.
  153.     Needs much cpu power to work correcty.
  154. -speed <n>:
  155.     change the base tempo to n. The normal value is 50 (PAL video
  156.     frequency). Some modules have been written on a buggy NTSC composer,
  157.     so you may wish to use -speed 60. Weird values like -speed 10 or
  158.     -speed 2000 are allowable. 
  159.     Note that the samples may sound a bit strange since you only change
  160.     the tempo there.
  161. -transpose <k>:
  162.     transpose the song up k half-notes. Doesn't work all the time.
  163.     Doesn't work right most of the time. For fun only. If k is
  164.     negative, it obviously transposes the song down.
  165. -start n:
  166.     start the module at pattern number n instead of number 0
  167.  
  168.         Sample control:
  169.         --------------
  170. -cut all:
  171.     suppress all samples from the audio output.
  172. -add all
  173.     add all samples to the audio output
  174. -cut n:
  175.     cut sample number n from the audio output.
  176. -add n:
  177.     add sample number n to the audio output.
  178.  
  179.  
  180. Runtime control:
  181.     n: go to next song
  182.     r: restart current song
  183.     p: go to previous song
  184.     >: fast forward
  185.     <: rewind
  186.     S: NTSC tempo (60)
  187.     s: PAL tempo (50)
  188.     q
  189.     x
  190.     e: quit right away
  191.     <space>: pause
  192.  
  193.  
  194. Send bug reports to espie@ens.fr,
  195. encouragements and nice things to espie@ens.fr, zenith@dcs.warwick.ac.uk, 
  196. shaehnic@ucsd.edu, hsavolai@cc.helsinki.fi
  197. --
  198.  
  199.     Marc Espie, Paris, january 1993
  200.  
  201.